I. Cluster Commands

The cluster commands enable you to create and manage SpinServer clusters.

The cluster command node includes the following subnodes:

  • configuration

  • routes

  • status

Each of the subnode commands is described in detail, with parameters and arguments listed for each command.

Examples of command usage are included in the discussions.

Table of Contents
Cluster Configuration Commands —
cluster configuration disablehamode — Use the cluster configuration disablehamode command to disable high-availability (HA) mode for a two-node cluster.
cluster configuration enablehamode — Use the cluster configuration enablehamode command to enable high-availability (HA) mode for a two-node cluster.
cluster configuration modify — Use the cluster configuration modify command to change the configuration properties of a SpinServer cluster.
cluster configuration show — Use the cluster configuration show command to display configuration information for a SpinServer cluster.
Cluster Routes Commands —
cluster routes delete — Use the cluster routes delete command to delete a cluster route.
cluster routes new — Use the cluster routes new command to create a cluster route.
cluster routes show — Use the cluster routes delete command to display information about a cluster route.
Cluster Status Commands —
cluster status addepsilon — Use the cluster status addepsilon command to designate a SpinServer in a cluster as epsilon.
cluster status deletenode — Use the cluster status deletenode command to remove a SpinServer from a cluster.
cluster status disablenode — Use the cluster status disablenode command to remove a SpinServer from quorum voting in a cluster.
cluster status enablenode — Use the cluster status enablenode command to add a SpinServer to quorum voting in a cluster.
cluster status removeepsilon — Use the cluster status removeepsilon command to remove the designation of a SpinServer as epsilon in a cluster.
cluster status show — Use the cluster status show command to display configuration information about SpinServers in a cluster.

Cluster Configuration Commands

Name

Cluster Configuration Commands -- 

The cluster configuration subnode enables you to work with audit-log settings. The subnode includes the following leaf-node commands:


cluster configuration disablehamode

Name

cluster configuration disablehamode -- Use the cluster configuration disablehamode command to disable high-availability (HA) mode for a two-node cluster.

Synopsis

CLI:

cluster configuration disablehamode -ssid spinserver

GUI: Navigate to the Cluster → Configuration node, then select the appropriate SpinServer from the table and run the Disable 2-node HA Mode command from the drop-down menu of the action pane.

Description

The cluster configuration disablehamode command is used to disable HA mode for a two-node cluster.

Options

-ssid spinserver

This is the ID given to the SpinServer.

Example

The following CLI example disables HA mode in a two-node cluster that contains a SpinServer named Server1.

spinserver::> cluster configuration disablehamode -ssid Server1

cluster configuration enablehamode

Name

cluster configuration enablehamode -- Use the cluster configuration enablehamode command to enable high-availability (HA) mode for a two-node cluster.

Synopsis

CLI:

cluster configuration enablehamode -ssid spinserver

GUI: Navigate to the Cluster → Configuration node, then select the appropriate SpinServer from the table and run the Enable 2-node HA Mode command from the drop-down menu of the action pane.

Description

The cluster configuration enablehamode command is used to enable HA mode for a two-node cluster.

Note: This command is required to enable high availability in the special case of a two-node cluster. Do not run this command in a high-availability configuration that has three or more nodes.

Options

-ssid spinserver

This is the ID given to the SpinServer.

Example

The following CLI example enables HA mode in a two-node cluster that contains a SpinServer named Server1.

spinserver::> cluster configuration enablehamode -ssid Server1

cluster configuration modify

Name

cluster configuration modify -- Use the cluster configuration modify command to change the configuration properties of a SpinServer cluster.

Synopsis

CLI:

cluster configuration modify -clustername cluster_name -auditlogsize audit_log_size -mailfrom mail_from_address -mailserver outbound_mail_server -unifiedcache {true | false} -sendmessage {true | false}

GUI: Navigate to the Cluster → Configuration node, then select the appropriate cluster from the table and run the Show command from the drop-down menu of the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.

Description

The cluster configuration modify command can change the following cluster attributes:

Options

-clustername cluster_name

This is the name of the cluster.

-auditlogsize audit_log_size

This is number of commands that are recorded in the audit log. The default is 10. The lower limit is 10, and the upper limit is 10,000.

-mailfrom mail_from_address

This is the mail-from address for email messages sent by the SpinServer.

-mailserver outbound_mail_server

This specifies the name of the outbound mail server for messages.

-unifiedcache {true | false}

This specifies whether the unified cache scheme is enabled for the cluster. The default is false.

-sendmessage {true | false}

This specifies whether a message is issued when a SpinServer in the cluster is restarted. The default is true.

Example

The following example changes the size of the audit log to 5000 commands in a cluster named cluster1. The mail-from address is set to postmaster@spincluster.example.com and the outbound mail server is specified as smtp1.example.com. The unified cache scheme is enabled, and restart messages are disabled.

spinserver::> cluster configuration modify -clustername cluster1 -auditlogsize 5000 -mailfrom postmaster@spincluster.example.com -mailserver smtp1.example.com -unifiedcache true -sendmessage false

cluster configuration show

Name

cluster configuration show -- Use the cluster configuration show command to display configuration information for a SpinServer cluster.

Synopsis

CLI:

cluster configuration show [-clustername cluster_name]

GUI: Navigate to the Cluster → Configuration node. To display specific information about the cluster, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The cluster configuration show command displays the following information about a cluster:

Options

[-clustername cluster_name]

This is the name of the cluster.

Example

The following CLI example displays the audit-log size for a cluster named cluster1:

spinserver::> cluster configuration show -clustername cluster1
   Cluster Name                   cluster1                                     
   AuditLog Size                  2000                                    
   Mail From                      postmaster@10.3.129.40                  
   Outging SMTP Server            foo                                     
   Unified Cache Scheme Enabled   true                                    

Cluster Routes Commands

Name

Cluster Routes Commands -- 

The cluster routes subnode includes the following leaf-node commands:


cluster routes delete

Name

cluster routes delete -- Use the cluster routes delete command to delete a cluster route.

Synopsis

CLI:

cluster routes delete -portname port_name -nexthop next_hop_IP_address -netnumber network_IP_address -netmask netmask

GUI: Navigate to the Cluster → Routes node, then select the appropriate SpinServer from the table and run the Delete command from the drop-down menu of the action pane.

Description

The cluster routes delete command is used to delete a route from a cluster.

Options

-portname port_name

This is the name of the port.

-nexthop next_hop_IP_address

This specifies the next-hop IP address.

-netnumber network_IP_address

This is the network IP address.

-netmask netmask

This is the network IP mask.

Example

The following CLI example deletes a cluster route on port clus0 with a next-hop address of 127.127.0.0, a network IP address of 127.64.7.1, and a netmask of255.255.0.0.

spinserver::> cluster routes delete -portname clus0 -nexthop 127.127.0.0 -netnumber 127.64.7.1 -netmask 255.255.0.0

cluster routes new

Name

cluster routes new -- Use the cluster routes new command to create a cluster route.

Synopsis

CLI:

cluster routes new -portname port_name -nexthop next_hop_IP_address -netnumber network_IP_address -netmask netmask -metric metric

GUI: Navigate to the Cluster → Routes node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed, then click Create.

Description

The cluster routes new command is used to create a cluster route.

Options

-portname port_name

This is the name of the port.

-nexthop next_hop_IP_address

This specifies the next-hop IP address.

-netnumber network_IP_address

This is the network IP address.

-netmask netmask

This is the network IP mask.

-metric metric

This is the metric used for the route. Specify 1 for the most direct route.

Example

The following CLI example creates a cluster route on port clus0 with a next-hop address of 127.127.0.0, a network IP address of 127.64.7.1, and a netmask of 255.255.0.0.

spinserver::> cluster routes new -portname clus0 -nexthop 127.127.0.0 -netnumber 127.64.7.1 -netmask 255.255.0.0 -metric 1

cluster routes show

Name

cluster routes show -- Use the cluster routes delete command to display information about a cluster route.

Synopsis

CLI:

cluster routes show [-portname port_name -nexthop next_hop_IP_address -netnumber network_IP_address -netmask netmask]

GUI: Navigate to the Cluster → Routes node. To display information about a specific route, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The cluster routes show command is used to display information about one or more cluster routes. The information includes the following:

Options

-portname port_name

This is the name of the port.

-nexthop next_hop_IP_address

This specifies the next-hop IP address.

-netnumber network_IP_address

This is the network IP address.

-netmask netmask

This is the network IP mask.

Example

The following CLI example displays information about all cluster routes:

spinserver::> cluster routes show
Port Name         Gateway Address  Network Address    Network Mask   Metric
clus0             127.127.0.0      127.64.7.1         255.255.0.0    1
clus1             127.127.0.0.     127.64.8.1         255.255.0.0    1

Cluster Status Commands

Name

Cluster Status Commands -- 

The cluster status subnode includes the following leaf-node commands:


cluster status addepsilon

Name

cluster status addepsilon -- Use the cluster status addepsilon command to designate a SpinServer in a cluster as epsilon.

Synopsis

CLI:

cluster status addepsilon -ssid spinserver

GUI: Navigate to the Cluster → Status node, then select the appropriate SpinServer from the table and run the Add Epsilon command from the drop-down menu of the action pane.

Description

The cluster status addepsilon command is used to designate a SpinServer in a cluster as epsilon. Epsilon enables a quorum to form by using slightly weaker requirements; for example, two out of four eligible nodes are sufficient if one of those two nodes holds epsilon.

Options

-ssid spinserver

This is the ID given to the SpinServer.

Example

The following CLI example designates a SpinServer named Server1 as epsilon in a cluster.

spinserver::> cluster status addepsilon -ssid Server1 

cluster status deletenode

Name

cluster status deletenode -- Use the cluster status deletenode command to remove a SpinServer from a cluster.

Synopsis

CLI:

cluster status deletenode -ssid spinserver -force {true | false}

GUI: Navigate to the Cluster → Status node, then select the appropriate SpinServer from the table and run the Delete Node command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed, then click Delete Node.

Description

The cluster status deletenode command removes a SpinServer from a cluster and deletes all of its configuration data. This operation cannot be undone. To return a SpinServer to a cluster, use the spinservers joincluster command.

Options

-ssid spinserver

This is the ID given to the SpinServer.

-force {true | false}

This specifies whether the deletion operation is forced. The default is false.

Example

The following command example removes a SpinServer named Server1 from its cluster. The deletion operation is not forced.

spinserver::> cluster status deletenode -ssid Server1 -force false

cluster status disablenode

Name

cluster status disablenode -- Use the cluster status disablenode command to remove a SpinServer from quorum voting in a cluster.

Synopsis

CLI:

cluster status disablenode -ssid spinserver

GUI: Navigate to the Cluster → Status node, then select the appropriate SpinServer from the table and run the Disable Node command from the drop-down menu of the action pane.

Description

The cluster status disablenode command is used to remove a SpinServer from quorum voting in a cluster. Disabling a SpinServer from participating in quorum voting changes the conditions under which quorum can be maintained. Quorum is maintained when half or more of the SpinServers that are eligible to vote respond in a positive, healthy manner.

Note: The cluster status disablenode command cannot be run on the node that you are disabling. Run this command on another node in the cluster, and specify the node that is to be disabled by using the -ssid parameter.

Options

-ssid spinserver

This is the ID given to the SpinServer.

Example

The following command example removes a SpinServer named Server1 from quorum voting in a cluster.

spinserver::> cluster status disablenode -ssid Server1

cluster status enablenode

Name

cluster status enablenode -- Use the cluster status enablenode command to add a SpinServer to quorum voting in a cluster.

Synopsis

CLI:

cluster status enablenode -ssid spinserver 

GUI: Navigate to the Cluster → Status node, then select the appropriate SpinServer from the table and run the Enable Node command from the drop-down menu of the action pane.

Description

The cluster status enablenode command is used to add a SpinServer to quorum voting in a cluster. Enabling a SpinServer to participate in quorum voting changes the conditions under which quorum can be maintained. Quorum is maintained when half or more of the SpinServers that are eligible to vote respond in a positive, healthy manner.

Note: The cluster status enablenode command cannot be run on the node that you are enabling. Run this command on a node that is already a member of the cluster, and specify the node that is to be enabled by using the -ssid parameter.

Options

-ssid spinserver

This is the ID given to the SpinServer.

Example

The following command example adds a SpinServer named Server1 to quorum voting in a cluster.

spinserver::> cluster status enablenode -ssid Server1

cluster status removeepsilon

Name

cluster status removeepsilon -- Use the cluster status removeepsilon command to remove the designation of a SpinServer as epsilon in a cluster.

Synopsis

CLI:

cluster status removeepsilon -ssid spinserver 

GUI: Navigate to the Cluster → Status node, then select the appropriate SpinServer from the table and run the Remove Epsilon command from the drop-down menu of the action pane.

Description

The cluster status removeepsilon command is used to remove the designation of a SpinServer as epsilon in cluster. Epsilon enables a quorum to form by using slightly weaker requirements; for example, two out of four eligible nodes are sufficient if one of those two nodes holds epsilon.

Options

-ssid spinserver

This is the ID given to the SpinServer.

Example

The following command example removes the designation of a SpinServer named Server1 as epsilon in a cluster.

spinserver::> cluster status removeepsilon -ssid Server1

cluster status show

Name

cluster status show -- Use the cluster status show command to display configuration information about SpinServers in a cluster.

Synopsis

CLI:

cluster status show [-ssid spinserver] 

GUI: Navigate to the Cluster → Status node. To display information about a specific SpinServer, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The cluster status show command is used to display configuration information about SpinServers in a cluster. The following information is displayed:

Options

[-ssid spinserver]

This is the ID given to the SpinServer.

Example

The following example displays configuration information about all SpinServers in a cluster:

spinserver::> cluster status show
Hostname   Cluster IP 1     Cluster IP 2   Epsilon Node State  Health 
                                                                      
Server1   10.3.128.20      10.3.128.28      true    Eligible   Online  
Server2   10.3.128.21      10.3.128.27      false   Eligible   Online

The following example displays configuration information about a SpinServer named Server10:

spinserver::> cluster status show -ssid Server10
   Hostname       Server10
   Cluster IP 1   10.3.128.19
   Cluster IP 2   10.3.128.19
   Epsilon        false
   Node State     Eligible
   Health         Online

Copyright © 2004 Network Appliance, Inc.; copyright © 2003, 2004 Spinnaker Networks, LLC. All rights reserved. Specifications subject to change without notice.